---
title: Hyper Link
icon: Link
---

<MetaData
  lang="en-US"
  meta={{
    preset: [{
      client: '@univerjs/preset-docs-hyper-link',
      locale: '@univerjs/preset-docs-hyper-link/locales/en-US',
      style: '@univerjs/preset-docs-hyper-link/lib/index.css',
    }],
    plugins: [{
      client: '@univerjs/docs-hyper-link',
    }, {
      client: '@univerjs/docs-hyper-link-ui',
      locale: '@univerjs/docs-hyper-link-ui/locales/en-US',
      style: '@univerjs/docs-hyper-link-ui/lib/index.css',
    }],
    server: 'No',
  }}
/>

Hyperlinks are used to quickly navigate and access external web pages, email addresses, and other content in documents.

## Preset Mode

### Installation

```package-install
npm install @univerjs/preset-docs-hyper-link
```

### Usage

```typescript
import { UniverDocsCorePreset } from '@univerjs/preset-docs-core'
import UniverPresetDocsCoreEnUS from '@univerjs/preset-docs-core/locales/en-US'
import { UniverDocsHyperLinkPreset } from '@univerjs/preset-docs-hyper-link' // [!code ++]
import UniverPresetDocsHyperLinkEnUS from '@univerjs/preset-docs-hyper-link/locales/en-US' // [!code ++]
import { createUniver, LocaleType, mergeLocales } from '@univerjs/presets'

import '@univerjs/preset-docs-core/lib/index.css'
import '@univerjs/preset-docs-hyper-link/lib/index.css' // [!code ++]

const { univerAPI } = createUniver({
  locale: LocaleType.EN_US,
  locales: {
    [LocaleType.EN_US]: mergeLocales(
      UniverPresetDocsCoreEnUS,
      UniverPresetDocsHyperLinkEnUS, // [!code ++]
    ),
  },
  presets: [
    UniverDocsCorePreset(),
    UniverDocsHyperLinkPreset(), // [!code ++]
  ],
})
```

{/* ### Presets and Configuration */}

## Plugin Mode

### Installation

```package-install
npm install @univerjs/docs-hyper-link @univerjs/docs-hyper-link-ui
```

### Usage

```typescript
import { LocaleType, mergeLocales, Univer } from '@univerjs/core'
import { UniverDocsHyperLinkPlugin } from '@univerjs/docs-hyper-link' // [!code ++]
import { UniverDocsHyperLinkUIPlugin } from '@univerjs/docs-hyper-link-ui' // [!code ++]
import DocsHyperLinkUIEnUS from '@univerjs/docs-hyper-link-ui/locale/en-US' // [!code ++]

import '@univerjs/docs-hyper-link-ui/lib/index.css' // [!code ++]

const univer = new Univer({
  locale: LocaleType.EN_US,
  locales: {
    [LocaleType.EN_US]: mergeLocales(
      DocsHyperLinkUIEnUS, // [!code ++]
    ),
  },
})

univer.registerPlugin(UniverDocsHyperLinkPlugin) // [!code ++]
univer.registerPlugin(UniverDocsHyperLinkUIPlugin) // [!code ++]
```

{/* ### Plugins and Configuration */}
